<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><link rel="stylesheet" type="text/css" href="style.css" /><script type="text/javascript" src="highlight.js"></script></head><body><pre><span class="hs-pragma">{-# LANGUAGE Trustworthy #-}</span><span>
</span><span id="line-2"></span><span class="hs-pragma">{-# LANGUAGE NoImplicitPrelude #-}</span><span>
</span><span id="line-3"></span><span>
</span><span id="line-4"></span><span class="hs-comment">-----------------------------------------------------------------------------</span><span>
</span><span id="line-5"></span><span class="hs-comment">-- |</span><span>
</span><span id="line-6"></span><span class="hs-comment">-- Module      :  Foreign.StablePtr</span><span>
</span><span id="line-7"></span><span class="hs-comment">-- Copyright   :  (c) The University of Glasgow 2001</span><span>
</span><span id="line-8"></span><span class="hs-comment">-- License     :  BSD-style (see the file libraries/base/LICENSE)</span><span>
</span><span id="line-9"></span><span class="hs-comment">-- </span><span>
</span><span id="line-10"></span><span class="hs-comment">-- Maintainer  :  ffi@haskell.org</span><span>
</span><span id="line-11"></span><span class="hs-comment">-- Stability   :  provisional</span><span>
</span><span id="line-12"></span><span class="hs-comment">-- Portability :  portable</span><span>
</span><span id="line-13"></span><span class="hs-comment">--</span><span>
</span><span id="line-14"></span><span class="hs-comment">-- This module is part of the Foreign Function Interface (FFI) and will usually</span><span>
</span><span id="line-15"></span><span class="hs-comment">-- be imported via the module &quot;Foreign&quot;.</span><span>
</span><span id="line-16"></span><span class="hs-comment">--</span><span>
</span><span id="line-17"></span><span class="hs-comment">-----------------------------------------------------------------------------</span><span>
</span><span id="line-18"></span><span>
</span><span id="line-19"></span><span>
</span><span id="line-20"></span><span class="hs-keyword">module</span><span> </span><span class="hs-identifier">Foreign.StablePtr</span><span>
</span><span id="line-21"></span><span>        </span><span class="hs-special">(</span><span> </span><span class="annot"><span class="hs-comment">-- * Stable references to Haskell values</span></span><span>
</span><span id="line-22"></span><span>          </span><span class="annot"><a href="GHC.Stable.html#StablePtr"><span class="hs-identifier">StablePtr</span></a></span><span>          </span><span class="hs-comment">-- abstract</span><span>
</span><span id="line-23"></span><span>        </span><span class="hs-special">,</span><span> </span><span class="annot"><a href="GHC.Stable.html#newStablePtr"><span class="hs-identifier">newStablePtr</span></a></span><span>
</span><span id="line-24"></span><span>        </span><span class="hs-special">,</span><span> </span><span class="annot"><a href="GHC.Stable.html#deRefStablePtr"><span class="hs-identifier">deRefStablePtr</span></a></span><span>
</span><span id="line-25"></span><span>        </span><span class="hs-special">,</span><span> </span><span class="annot"><a href="GHC.Stable.html#freeStablePtr"><span class="hs-identifier">freeStablePtr</span></a></span><span>
</span><span id="line-26"></span><span>        </span><span class="hs-special">,</span><span> </span><span class="annot"><a href="GHC.Stable.html#castStablePtrToPtr"><span class="hs-identifier">castStablePtrToPtr</span></a></span><span>
</span><span id="line-27"></span><span>        </span><span class="hs-special">,</span><span> </span><span class="annot"><a href="GHC.Stable.html#castPtrToStablePtr"><span class="hs-identifier">castPtrToStablePtr</span></a></span><span>
</span><span id="line-28"></span><span>        </span><span class="hs-special">,</span><span> </span><span class="annot"><span class="hs-comment">-- ** The C-side interface</span></span><span>
</span><span id="line-29"></span><span>
</span><span id="line-30"></span><span>          </span><span class="annot"><span class="hs-comment">-- $cinterface</span></span><span>
</span><span id="line-31"></span><span>        </span><span class="hs-special">)</span><span> </span><span class="hs-keyword">where</span><span>
</span><span id="line-32"></span><span>
</span><span id="line-33"></span><span class="hs-keyword">import</span><span> </span><span class="annot"><a href="GHC.Stable.html"><span class="hs-identifier">GHC.Stable</span></a></span><span>
</span><span id="line-34"></span><span>
</span><span id="line-35"></span><span class="hs-comment">-- $cinterface</span><span>
</span><span id="line-36"></span><span class="hs-comment">--</span><span>
</span><span id="line-37"></span><span class="hs-comment">-- The following definition is available to C programs inter-operating with</span><span>
</span><span id="line-38"></span><span class="hs-comment">-- Haskell code when including the header @HsFFI.h@.</span><span>
</span><span id="line-39"></span><span class="hs-comment">--</span><span>
</span><span id="line-40"></span><span class="hs-comment">-- &gt; typedef void *HsStablePtr;  /* C representation of a StablePtr */</span><span>
</span><span id="line-41"></span><span class="hs-comment">--</span><span>
</span><span id="line-42"></span><span class="hs-comment">-- Note that no assumptions may be made about the values representing stable</span><span>
</span><span id="line-43"></span><span class="hs-comment">-- pointers.  In fact, they need not even be valid memory addresses.  The only</span><span>
</span><span id="line-44"></span><span class="hs-comment">-- guarantee provided is that if they are passed back to Haskell land, the</span><span>
</span><span id="line-45"></span><span class="hs-comment">-- function 'deRefStablePtr' will be able to reconstruct the</span><span>
</span><span id="line-46"></span><span class="hs-comment">-- Haskell value referred to by the stable pointer.</span><span>
</span><span id="line-47"></span><span>
</span><span id="line-48"></span></pre></body></html>